Skip to content

docs: Add bb cli reference#17215

Closed
marciw-aztec wants to merge 6 commits intonextfrom
mw/bb-cli-docs
Closed

docs: Add bb cli reference#17215
marciw-aztec wants to merge 6 commits intonextfrom
mw/bb-cli-docs

Conversation

@marciw-aztec
Copy link
Contributor

This PR adds documentation for the bb CLI, based on help output from v0.87.3.

Changes:

  • New file: barretenberg/docs/docs/bb-cli-reference.md
  • Covers bb commands and options, with examples
  • Adds consistent formatting and usage patterns
  • Includes significant edits to original help text, mostly for clarity and conciseness

Notes for reviewers:

  • includes Claude-generated context and examples that need technical review 🤖
  • includes an Installation section. not sure we want to keep it?

Addresses https://linear.app/aztec-labs/issue/ECODR-145/add-bb-cli-docs-to-barretenberg-docs (TODOs tracked there)

@critesjosh
Copy link
Contributor

critesjosh commented Sep 23, 2025

Thanks Marci! Yep this is what I had in mind. It'd be great to figure out how to autogenerate this doc as new versions are released so we don't have to do it manually, but perhaps we can do that in a future PR.

For now, can you check that it's the same for version 0.87.0 as for 0.87.3 that you added here, and add it to the versioned docs here? For reference, we are only publishing the files from versioned_docs, so any changes in docs/docs wont show up on the published site. What's in docs/docs gets released every night as part of the nightly release process, and will show up in the nightly version tomorrow. https://github.com/AztecProtocol/aztec-packages/tree/mw/bb-cli-docs/barretenberg/docs/versioned_docs/version-v0.87.0

I'm reluctant to hard-code the CLI docs in docs/docs since changes could go unnoticed and it's worse to have wrong CLI docs than no CLI docs, since they can always be retrieved with bb -h.

image

@marciw-aztec
Copy link
Contributor Author

thanks! I've confirmed that 0.87.0 and 0.87.3 are the same.

I'm reluctant to hard-code the CLI docs in docs/docs

Definitely wasn't trying to do anything like that. 😅 Just still clueless about docs builds, so thanks for the explanation!

I mis-rebased 🫠 so closing this in favor of #17244

@marciw-aztec
Copy link
Contributor Author

marciw-aztec commented Sep 23, 2025

@josh ah wait, one clarification: are you saying it should be in docs/docs and versioned-docs? Or only the latter?

Edit: figured it out; please disregard 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants